<!DOCTYPE html>

<html lang="en">
<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width">
	<title>Common Modules Source: map/Controls.js</title>

	<!--[if lt IE 9]>
	<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
	<![endif]-->
	<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">

	<link type="text/css" rel="stylesheet" href="styles/site.simplex.css">

</head>

<body>

<div class="navbar navbar-default navbar-fixed-top navbar-inverse">
<div class="container">
	<div class="navbar-header">
		<a class="navbar-brand" href="index.html">Common Modules</a>
		<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
			<span class="icon-bar"></span>
			<span class="icon-bar"></span>
			<span class="icon-bar"></span>
        </button>
	</div>
	<div class="navbar-collapse collapse" id="topNavigation">
		<ul class="nav navbar-nav">
			
			<li class="dropdown">
				<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="Base.html">Base</a></li><li><a href="Event.html">Event</a></li><li><a href="Html.html">Html</a></li><li><a href="Internal.html">Internal</a></li><li><a href="ol.Overlay.Popup.html">ol.Overlay.Popup</a></li>
				</ul>
			</li>
			
			<li class="dropdown">
				<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="global.html#addClass">addClass</a></li><li><a href="global.html#addListener">addListener</a></li><li><a href="global.html#arrayRemove">arrayRemove</a></li><li><a href="global.html#clear">clear</a></li><li><a href="global.html#create">create</a></li><li><a href="global.html#createHidden">createHidden</a></li><li><a href="global.html#empty">empty</a></li><li><a href="global.html#EventType">EventType</a></li><li><a href="global.html#findListener">findListener</a></li><li><a href="global.html#firstUpperToCase">firstUpperToCase</a></li><li><a href="global.html#get">get</a></li><li><a href="global.html#getChildByTagName">getChildByTagName</a></li><li><a href="global.html#getClass">getClass</a></li><li><a href="global.html#getDomEventKey">getDomEventKey</a></li><li><a href="global.html#getElementsByClassName">getElementsByClassName</a></li><li><a href="global.html#getListeners">getListeners</a></li><li><a href="global.html#getrandom">getrandom</a></li><li><a href="global.html#getStyle">getStyle</a></li><li><a href="global.html#getuuid">getuuid</a></li><li><a href="global.html#hasClass">hasClass</a></li><li><a href="global.html#isObject">isObject</a></li><li><a href="global.html#isString">isString</a></li><li><a href="global.html#layerConfigDefautls">layerConfigDefautls</a></li><li><a href="global.html#listen">listen</a></li><li><a href="global.html#listenOnce">listenOnce</a></li><li><a href="global.html#logo">logo</a></li><li><a href="global.html#OL_Style_Type">OL_Style_Type</a></li><li><a href="global.html#remove">remove</a></li><li><a href="global.html#removeClass">removeClass</a></li><li><a href="global.html#removeListener">removeListener</a></li><li><a href="global.html#removeListeners">removeListeners</a></li><li><a href="global.html#setClass">setClass</a></li><li><a href="global.html#splitWords">splitWords</a></li><li><a href="global.html#stamp">stamp</a></li><li><a href="global.html#toBack">toBack</a></li><li><a href="global.html#toFront">toFront</a></li><li><a href="global.html#trim">trim</a></li><li><a href="global.html#unListen">unListen</a></li><li><a href="global.html#unlistenAll">unlistenAll</a></li><li><a href="global.html#unListenByKey">unListenByKey</a></li><li><a href="global.html#upperFirstChart">upperFirstChart</a></li>
				</ul>
			</li>
			
		</ul>
        
            <div class="col-sm-3 col-md-3">
                <form class="navbar-form" role="search">
                    <div class="input-group">
                        <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
                        <div class="input-group-btn">
                            <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
                        </div>
                    </div>
                </form>
            </div>
        
	</div>

</div>
</div>


<div class="container" id="toc-content">
<div class="row">

	
	<div class="col-md-12">
	
		<div id="main">
			

		<h1 class="page-title">Source: map/Controls.js</h1>
    
<section>
    <article>
        <pre
            class="sunlight-highlight-javascript linenums">import {
    ol
} from '../constants'
import * as utils from '../utils/utils'
import '../control/BZoomSlider'
import '../control/FullScreen'
import '../control/zoom'
import '../control/compareLayer'
import '../control/contextMenu'
import '../control/LayerSwitcher'
import '../control/Loading'
import '../control/MousePosition'
import '../control/OverviewMap'
import '../control/RotateControl'
import '../control/ScaleLineH'
class _Controls {

    /**
   * 添加控件
   * @param params
   * @returns {Array}
   * @private
   */
  _addControls (params) {
    let options = params || {}
    let controls = []
    // 添加缩放
    if (!options.hasOwnProperty('zoom')) {
      this.addZoom({}, controls)
    }
    // 添加旋转
    if (!options.hasOwnProperty('rotate')) {
      this.addRotate({}, controls)
    }
    // 添加版权
    if (!options.hasOwnProperty('attribution')) {
      this.addAttribution({}, controls)
    }
    if (options) {
      for (let key in options) {
        if (key &amp;&amp; options[key]) {
          this['add' + (utils.upperFirstChart(key))](options[key], controls)
        }
      }
    }
    return controls
  }



    /**
     * 添加缩放按钮
     * @param options
     * @param controls
     * @private
     */
    addZoom(options = {}, controls) {
        controls = controls || this.map.getControls()
        controls.push(new ol.control.ZoomMenu({
            className: options['className'],
            duration: options['duration'],
            target: options['target'],
            delta: options['delta']
        }))
    }

    /**
     * 添加旋转控件
     * @param options
     * @param controls
     * @private
     */
    addRotate(options = {}, controls) {
        controls = controls || this.map.getControls()
        controls.push(new ol.control.RotateControl({
            className: options['className'],
            duration: options['duration'],
            label: options['resetNorth'],
            autoHide: options['autoHide'],
            target: options['target']
        }))
    }

    /**
     * 版权
     * @param options
     * @param controls
     * @private
     */
    addAttribution(options, controls) {

        controls = controls || this.map.getControls()
        controls.push(new ol.control.Attribution({
            className: (options['className'] ? options['className'] : 'ol-attribution'),
            label: (options['label'] ? options['label'] : 'i'),
            tipLabel: (options['tipLabel'] &amp;&amp; typeof options['tipLabel'] === 'string' ? options['tipLabel'] : '版权'),
            collapsible: (options['collapsible'] === false ? options['collapsible'] : true),
            collapsed: (options['collapsed'] === false ? options['collapsed'] : true),
            collapseLabel: (options['collapseLabel'] ? options['collapseLabel'] : '»'),
            target: (options['target'] ? options['target'] : undefined)
        }))
    }

    /**
     * 添加比例尺
     * @param options
     * @param controls
     * @private
     */
    addScaleLine(options, controls) {
        controls = controls || this.map.getControls()
        controls.push(new ol.control.ScaleLineH({
            units: (options['units'] ? options['units'] : 'metric_cn')
        }))
    }

    /**
     * 添加全屏控件
     * @param options
     * @param controls
     */
    addFullScreen(options = {}, controls) {
        controls = controls || this.map.getControls()
        controls.push(new ol.control.FullScreenMenu({
            className: options['className'],
            label: options['label'],
            labelActive: options['labelActive'],
            keys: options['keys'],
            target: options['target'],
            source: options['source']
        }))
    }

    /**
     * 添加鼠标位置控件
     * @param options
     * @param controls
     */
    addMousePosition(options = {}, controls) {
        controls = controls || this.map.getControls()
        controls.push(new ol.control.MousePosition({
            className: (options['className'] ? options['className'] : 'ol-mouse-position'),
            coordinateFormat: (options['coordinateFormat'] ? options['coordinateFormat'] : undefined),
            projection: (options['projection'] ? options['projection'] : this.view.getProjection()),
            undefinedHTML: (options['undefinedHTML'] &amp;&amp; typeof options['undefinedHTML'] === 'string' ? options['undefinedHTML'] : '无坐标'),
            target: (options['target'] ? options['target'] : undefined)
        }))
    }

    /**
     * 添加缩放条控件
     * @param options
     * @param controls
     */
    addZoomSlider(options, controls) {
        controls = controls || this.map.getControls()
        let zoomSlider = new ol.control.BZoomSlider({
            duration: options['duration'],
            pixelDelta: options['pixelDelta'],
            className: options['className'],
            target: options['target']
        })
        controls.push(zoomSlider)
    }

    /**
     * 添加缩放范围控件
     * @param options
     * @param controls
     */
    addZoomToExtent(options, controls) {
        controls = controls || this.map.getControls()
        controls.push(new ol.control.ZoomToExtent({
            className: (options['className'] ? options['className'] : 'ol-zoom-extent'),
            label: (options['label'] ? options['label'] : 'E'),
            tipLabel: (options['tipLabel'] &amp;&amp; typeof options['tipLabel'] === 'string' ? options['tipLabel'] : '缩放到范围'),
            extent: (options['extent'] ? options['extent'] : undefined)
        }))
    }

    /**
     * 添加定位控件
     * @param options
     * @param controls
     * @private
     */
    addGeolocation(options, controls) {
        controls = controls || this.map.getControls()
        controls.push(new ol.control.Geolocation({
            className: (options['className'] ? options['className'] : 'gmap-geolocation'),
            target: (options['target'] ? options['target'] : undefined)
        }))
    }

    /**
     * 添加loading控件
     * @param options
     * @param controls
     * @private
     */
    addLoading(options, controls) {
        controls = controls || this.map.getControls()
        let loading_ = new ol.control.Loading({
            className: (options['className'] ? options['className'] : 'gmap-loading-panel'),
            widget: (options['widget'] ? options['widget'] : 'animatedGif'),
            target: (options['target'] ? options['target'] : undefined)
        })
        controls.push(loading_)
    }

    /**
     * 添加CompareLayer控件
     * @param beforeMap
     * @param afterMap
     * @param options
     * @param controls
     * @private
     */
    addCompareLayer(beforeMap, afterMap, options = {}, controls) {
        controls = controls || this.map.getControls()
        let _compareLayer = new ol.control.CompareLayer(beforeMap, afterMap, options)
        controls.push(_compareLayer)
    }

    /**
     * 添加ContextMenu控件
     * @param options
     * @param controls
     * @private
     */
    addContextMenu(options = {}, controls) {
        controls = controls || this.map.getControls()
        let ContextMenu = new ol.control.ContextMenu(options)
        controls.push(ContextMenu)
    }

    /**
     * 添加LayerSwitcher控件
     * @param options
     * @param controls
     * @private
     */
    addLayerSwitcher(options = {}, controls) {
        controls = controls || this.map.getControls()
        let Switcher = new ol.control.LayerSwitcher(options)
        controls.push(Switcher)
    }

}

export default _Controls</pre>
    </article>
</section>





		</div>
	</div>

	<div class="clearfix"></div>

	

</div>
</div>


    <div class="modal fade" id="searchResults">
      <div class="modal-dialog">
        <div class="modal-content">
          <div class="modal-header">
            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
            <h4 class="modal-title">Search results</h4>
          </div>
          <div class="modal-body"></div>
          <div class="modal-footer">
            <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
          </div>
        </div><!-- /.modal-content -->
      </div><!-- /.modal-dialog -->
    </div>


<footer>


	<span class="copyright">
	https://lzw.me.
	</span>

<span class="jsdoc-message">
	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
	
		on Sun Aug 12th 2018
	
	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>

<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>

    <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>


<script>
$( function () {
	$( "[id*='$']" ).each( function () {
		var $this = $( this );

		$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
	} );

	$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
		var $this = $( this );

		var example = $this.find( "code" );
		exampleText = example.html();
		var lang = /{@lang (.*?)}/.exec( exampleText );
		if ( lang && lang[1] ) {
			exampleText = exampleText.replace( lang[0], "" );
			example.html( exampleText );
			lang = lang[1];
		} else {
			var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
			lang = langClassMatch ? langClassMatch[1] : "javascript";
		}

		if ( lang ) {

			$this
			.addClass( "sunlight-highlight-" + lang )
			.addClass( "linenums" )
			.html( example.html() );

		}
	} );

	Sunlight.highlightAll( {
		lineNumbers : true,
		showMenu : true,
		enableDoclinks : true
	} );

	$.catchAnchorLinks( {
        navbarOffset: 10
	} );
	$( "#toc" ).toc( {
		anchorName  : function ( i, heading, prefix ) {
			return $( heading ).attr( "id" ) || ( prefix + i );
		},
		selectors   : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
		showAndHide : false,
		smoothScrolling: true
	} );

	$( "#main span[id^='toc']" ).addClass( "toc-shim" );
	$( '.dropdown-toggle' ).dropdown();

    $( "table" ).each( function () {
      var $this = $( this );
      $this.addClass('table');
    } );

} );
</script>



<!--Navigation and Symbol Display-->


<!--Google Analytics-->



    <script type="text/javascript">
        $(document).ready(function() {
            SearcherDisplay.init();
        });
    </script>


</body>
</html>
